/*
 * Copyright 2010 Assert Developments
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package be.ad.coffeebreak.web;

/**
 * The command context, used by a command.
 *
 * @author Stefan Bangels
 * @see be.ad.coffeebreak.web.Command
 */
public interface CommandContext {

    /**
     * Returns true if the request should be interpreted as a get.
     *
     * @return returns true if it's a request
     */
    public boolean isRequest();

    /**
     * Returns true if the request should be interpreted as a submit.
     *
     * @return returns true if it's a submit request
     */
    public boolean isSubmit();

    /**
     * Get a request parameter.
     *
     * @param key the parameter key
     * @return the parameter value
     */
    public String getParameter(String key);

    /**
     * Sets a model attribute.
     *
     * @param key   the attribute key
     * @param value the attribute value
     */
    public void setModel(String key, Object value);

}
